@types/command-line-usage

What is @types/command-line-usage?

@types/command-line-usage provides TypeScript type definitions for the command-line-usage package, which is used to create usage guides for command-line applications. It helps in defining sections, options, and examples to display a well-structured help message.

What are @types/command-line-usage's main functionalities?

Defining Sections

This feature allows you to define different sections of the usage guide, such as headers and content. The code sample demonstrates how to create sections for a command-line application, including a header and options.

const commandLineUsage = require('command-line-usage');

const sections = [
  {
    header: 'My App',
    content: 'A brief description of my app.'
  },
  {
    header: 'Options',
    optionList: [
      {
        name: 'help',
        typeLabel: '{underline boolean}',
        description: 'Display this usage guide.'
      },
      {
        name: 'src',
        typeLabel: '{underline file}',
        description: 'The input files to process.'
      }
    ]
  }
];

const usage = commandLineUsage(sections);
console.log(usage);

Displaying Examples

This feature allows you to include examples in the usage guide. The code sample shows how to add an example section to the usage guide, demonstrating how to run the command-line application with specific options.

const commandLineUsage = require('command-line-usage');

const sections = [
  {
    header: 'Example',
    content: 'node myapp.js --src file.txt'
  }
];

const usage = commandLineUsage(sections);
console.log(usage);

Customizing Option Descriptions

This feature allows you to customize the descriptions and type labels for options. The code sample demonstrates how to define options with custom descriptions and type labels, providing more detailed information to the user.

const commandLineUsage = require('command-line-usage');

const sections = [
  {
    header: 'Options',
    optionList: [
      {
        name: 'verbose',
        description: 'Enable verbose mode.'
      },
      {
        name: 'timeout',
        typeLabel: '{underline ms}',
        description: 'Timeout value in milliseconds.'
      }
    ]
  }
];

const usage = commandLineUsage(sections);
console.log(usage);

Other packages similar to @types/command-line-usage

commander

Commander is a popular package for building command-line interfaces. It provides a comprehensive set of features for parsing command-line arguments, defining commands, and generating help messages. Compared to command-line-usage, Commander offers more functionality for command parsing and execution.

yargs

Yargs is another widely-used package for building command-line tools. It focuses on parsing arguments and generating user-friendly help messages. Yargs provides a rich set of features for handling complex command-line interfaces, making it a strong alternative to command-line-usage.

oclif

Oclif is a framework for building command-line interfaces with a focus on modularity and extensibility. It provides a robust set of tools for creating CLI applications, including argument parsing, command handling, and help generation. Oclif is more feature-rich and structured compared to command-line-usage.

README

Installation

npm install --save @types/command-line-usage

Summary

This package contains type definitions for command-line-usage (https://github.com/75lb/command-line-usage#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/command-line-usage.

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: none

Credits

These definitions were written by matrumz, and Andrija Dvorski.